Add support for representing patent information by stevespringett · Pull Request #597 · CycloneDX/specification

stevespringett · 2025-02-10T22:20:03Z

Implements patent support. Closes #596

TODO/DONE

Signed-off-by: Steve Springett <steve@springett.us>

Signed-off-by: steve.springett <steve.springett@servicenow.com>

tools/src/test/resources/1.7/valid-patent-1.7.json

stevespringett · 2025-03-10T18:16:56Z

@planetlevel would you be able to review this? We have worked with WIPO on providing summary information for patents and patent families and we believe our current support for both of these are correct. Let us know otherwise. However, I'm particularly interested in a review of the patent assertions which allow BOM creators to assert their relationship with the patent (owner, licensing, etc).

planetlevel · 2025-04-03T20:00:52Z

Hi Steve, I spent some time with this, and it looks pretty comprehensive. For all my experience with patents (IP degree from G'town, drafted several patents for big companies at a lawfirm, have 7-8 of my own)... I guess my patent experience has been pretty simple relative to these complex scenarios. Sorry I thought I could be more help here,

…

--Jeff 410-707-1487

On Mon, Mar 10, 2025 at 2:17 PM Steve Springett ***@***.***> wrote: @planetlevel <https://github.com/planetlevel> would you be able to review this? We have worked with WIPO on providing summary information for patents and patent families and we believe our current support for both of these are correct. Let us know otherwise. However, I'm particularly interested in a review of the patent assertions which allow BOM creators to assert their relationship with the patent (owner, licensing, etc). — Reply to this email directly, view it on GitHub <#597 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAUUFTHRYGRI6F6OVTPFO3D2TXQNZAVCNFSM6AAAAABW3U24E6VHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDOMJRGQ2DMMJQHA> . You are receiving this because you were mentioned.Message ID: ***@***.***> [image: stevespringett]*stevespringett* left a comment (CycloneDX/specification#597) <#597 (comment)> @planetlevel <https://github.com/planetlevel> would you be able to review this? We have worked with WIPO on providing summary information for patents and patent families and we believe our current support for both of these are correct. Let us know otherwise. However, I'm particularly interested in a review of the patent assertions which allow BOM creators to assert their relationship with the patent (owner, licensing, etc). — Reply to this email directly, view it on GitHub <#597 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAUUFTHRYGRI6F6OVTPFO3D2TXQNZAVCNFSM6AAAAABW3U24E6VHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDOMJRGQ2DMMJQHA> . You are receiving this because you were mentioned.Message ID: ***@***.***>

…est case Signed-off-by: Steve Springett <steve@springett.us>

Signed-off-by: Steve Springett <steve@springett.us>

stevespringett · 2025-05-02T04:00:47Z

@jkowalleck do you know what's up with the Java checker? It's failing on the valid-standard-1.7 test file, which is not part of this PR, and was never failing previously to my knowledge. Also, the PHP one is not returning any useful information, just a generic error.

jkowalleck · 2025-05-02T12:11:07Z

@jkowalleck do you know what's up with the Java checker? It's failing on the valid-standard-1.7 test file, which is not part of this PR, and was never failing previously to my knowledge. Also, the PHP one is not returning any useful information, just a generic error.

did not look into details of this PR, but is suspect the XSD changes are breaking things unintentionally.
if I should guess, it is that a XML element patents is missing the intended min-occurrence, which makes it required - which breaks existing test cases.

https://github.com/CycloneDX/specification/actions/runs/14794751751/job/41539253573?pr=597#step:5:1237


test /home/runner/work/specification/specification/tools/src/test/resources/1.7/valid-standard-1.7.xml ...
ERROR: Unexpected validation error for file: /home/runner/work/specification/specification/tools/src/test/resources/1.7/valid-standard-1.7.xml
LibXMLError Object
(
    [level] => 2
    [code] => 1871
    [column] => 0
    [message] => Element '{http://cyclonedx.org/schema/bom/1.7}definitions': Missing child element(s). Expected is ( {http://cyclonedx.org/schema/bom/1.7}patents ).

    [file] => /home/runner/work/specification/specification/tools/src/test/php/
    [line] => 3
)

https://github.com/CycloneDX/specification/actions/runs/14794751743/job/41539253424?pr=597#step:4:2194

Error:  Tests run: 395, Failures: 1, Errors: 0, Skipped: 0, Time elapsed: 0.899 s <<< FAILURE! -- in org.cyclonedx.schema.XmlSchemaVerificationTest
Error:  org.cyclonedx.schema.XmlSchemaVerificationTest.dynamicTestsWithCollection()[392] -- Time elapsed: 0.007 s <<< FAILURE!
org.opentest4j.AssertionFailedError: 1.7/valid-standard-1.7.xml ==> expected: <true> but was: <false>
	at org.junit.jupiter.api.AssertionFailureBuilder.build(AssertionFailureBuilder.java:151)
	at org.junit.jupiter.api.AssertionFailureBuilder.buildAndThrow(AssertionFailureBuilder.java:132)
	at org.junit.jupiter.api.AssertTrue.failNotTrue(AssertTrue.java:63)
	at org.junit.jupiter.api.AssertTrue.assertTrue(AssertTrue.java:36)
	at org.junit.jupiter.api.Assertions.assertTrue(Assertions.java:214)
	at org.cyclonedx.schema.XmlSchemaVerificationTest.lambda$dynamicTestsWithCollection$0(XmlSchemaVerificationTest.java:84)
	at java.util.Optional.ifPresent(Optional.java:159)
	at java.util.ArrayList.forEach(ArrayList.java:1259)
	at java.util.ArrayList.forEach(ArrayList.java:1259)

Signed-off-by: Steve Springett <steve@springett.us>

stevespringett · 2025-05-02T16:39:25Z

Ah, that makes sense. Thanks for the guidance.

Signed-off-by: Steve Springett <steve@springett.us>

Signed-off-by: Jan Kowalleck <jan.kowalleck@gmail.com>

jkowalleck

did a complete review of all changes.

the JSON, the XML, and the PB are consistent.
data models made sense - thanks to the good documentation/annotation

jkowalleck · 2025-06-05T08:47:01Z

RFC notice sent on May 3, 2025

Public RFC period ended May 31, 2025

jkowalleck · 2025-06-05T15:17:05Z

this one just was accepted during a Ecma TC54 meeting 👍

Nicolas-Peiffer · 2025-06-06T08:56:59Z

Great news 🚀 , and great result. Thank you ❤️ to all the people involved.

## Fixed * XML schema: add type for `ComponentData` sub-elements ([#600] via [#601]) * JSON schema: added the correct `deprecated` mark for already deprecated structures (via [a973a6b]) ## Deprecated * Deprecated various fields and structures related to _cryptographic transparency_ - _CBOM_ . (via [#657]) Use the newly added structures and fields for detailing the information instead. ## Changed * Extended the scope of _formulations_. (via [#647]) From now on, _formulations_ may be used to describe how any referencable object within the BOM came together, including components, services, metadata, declarations, or the BOM itself. Before, it was restricted to components and services. ## Added * Support for _external components_ with _version-ranges_ ([#321] via [#586]) * Support for _multiple_ SPDX License Expressions alongside with other licenses ([#454] via [#582]) * Support for _Streebog hashing algorithm_ ([#485] via [#525]) * Support for license expression _details and properties_ ([#549], [#554] via [#599]) * Support for expressing BOM distribution constraints with the _Traffic Light Protocol_ (TLP) in metadata ([#595] via [#604], [#653]) * Support for representing _patent information_ ([#596] via [#597]) * Support for _properties_ on external-references ([#608] via [#610]) * Support for _citations_ ([#630] via [#629]) * Support for detailing _cryptographic transparency_ information - _CBOM_ ([#569] via [#657]) ## Documentation * Elaborated component classification "platform", explicitly expressed that it includes just-in-time compilers and interpreters ([#233] via [#647]) * Removed the term "optional" from the schema where the definition was already unambiguous ([#616], [#649] via [#680]) ## Test data * Add test data for CycloneDX 1.7 implementations in XML, JSON, Protobuf [#233]: #233 [#321]: #321 [#454]: #454 [#485]: #485 [#525]: #525 [#549]: #549 [#554]: #554 [#569]: #569 [#582]: #582 [#586]: #586 [#595]: #595 [#596]: #596 [#597]: #597 [#599]: #599 [#600]: #600 [#601]: #601 [#604]: #604 [#608]: #608 [#610]: #610 [#616]: #616 [#629]: #629 [#630]: #630 [#647]: #647 [#649]: #649 [#653]: #653 [#657]: #657 [#680]: #680 [a973a6b]: a973a6b ---- - fixes #233 - fixes #321 - fixes #454 - fixes #485 - fixes #549 - fixes #554 - fixes #595 - fixes #596 - fixes #600 - fixes #608 - fixes #629 - fixes #616 - fixes #649

## Fixed * XML schema: add type for `ComponentData` sub-elements ([#600] via [#601]) * JSON schema: added the correct `deprecated` mark for already deprecated structures (via [a973a6b]) ## Deprecated * Deprecated various fields and structures related to _cryptographic transparency_ - _CBOM_ . (via [#657]) Use the newly added structures and fields for detailing the information instead. ## Changed * Extended the scope of _formulations_. (via [#647]) From now on, _formulations_ may be used to describe how any referencable object within the BOM came together, including components, services, metadata, declarations, or the BOM itself. Before, it was restricted to components and services. ## Added * Support for _external components_ with _version-ranges_ ([#321] via [#586]) * Support for _multiple_ SPDX License Expressions alongside with other licenses ([#454] via [#582]) * Support for _Streebog hashing algorithm_ ([#485] via [#525]) * Support for license expression _details and properties_ ([#549], [#554] via [#599]) * Support for expressing BOM distribution constraints with the _Traffic Light Protocol_ (TLP) in metadata ([#595] via [#604], [#653]) * Support for representing _patent information_ ([#596] via [#597]) * Support for _properties_ on external-references ([#608] via [#610]) * Support for _citations_ ([#630] via [#629]) * Support for detailing _cryptographic transparency_ information - _CBOM_ ([#569] via [#657]) ## Documentation * Elaborated component classification "platform", explicitly expressed that it includes just-in-time compilers and interpreters ([#233] via [#647]) * Removed the term "optional" from the schema where the definition was already unambiguous ([#616], [#649] via [#680]) ## Test data * Add test data for CycloneDX 1.7 implementations in XML, JSON, Protobuf [#233]: CycloneDX/specification#233 [#321]: CycloneDX/specification#321 [#454]: CycloneDX/specification#454 [#485]: CycloneDX/specification#485 [#525]: CycloneDX/specification#525 [#549]: CycloneDX/specification#549 [#554]: CycloneDX/specification#554 [#569]: CycloneDX/specification#569 [#582]: CycloneDX/specification#582 [#586]: CycloneDX/specification#586 [#595]: CycloneDX/specification#595 [#596]: CycloneDX/specification#596 [#597]: CycloneDX/specification#597 [#599]: CycloneDX/specification#599 [#600]: CycloneDX/specification#600 [#601]: CycloneDX/specification#601 [#604]: CycloneDX/specification#604 [#608]: CycloneDX/specification#608 [#610]: CycloneDX/specification#610 [#616]: CycloneDX/specification#616 [#629]: CycloneDX/specification#629 [#630]: CycloneDX/specification#630 [#647]: CycloneDX/specification#647 [#649]: CycloneDX/specification#649 [#653]: CycloneDX/specification#653 [#657]: CycloneDX/specification#657 [#680]: CycloneDX/specification#680 [a973a6b]: CycloneDX/specification@a973a6b ---- - fixes #233 - fixes #321 - fixes #454 - fixes #485 - fixes #549 - fixes #554 - fixes #595 - fixes #596 - fixes #600 - fixes #608 - fixes #629 - fixes #616 - fixes #649

Initial checkin of patent support

45af9ec

Signed-off-by: Steve Springett <steve@springett.us>

stevespringett changed the title ~~Initial checkin of patent support~~ Add patent support Feb 10, 2025

stevespringett linked an issue Feb 11, 2025 that may be closed by this pull request

[FEATURE]: Add support for referencing patent information #596

Closed

jkowalleck added the proposed core enhancement label Feb 11, 2025

jkowalleck changed the title ~~Add patent support~~ [WIP] v1.7 - Add patent support Feb 12, 2025

jkowalleck added this to the 1.7 milestone Feb 17, 2025

jkowalleck and others added 2 commits February 17, 2025 20:23

Merge branch '1.7-dev' into 1.7-dev-patents

0f6d558

Added missing doc

1f333ed

Signed-off-by: steve.springett <steve.springett@servicenow.com>

dasarpjonam reviewed Mar 10, 2025

View reviewed changes

tools/src/test/resources/1.7/valid-patent-1.7.json Show resolved Hide resolved

jkowalleck and others added 3 commits April 14, 2025 08:17

Merge branch '1.7-dev' into 1.7-dev-patents

1cc3320

Corrected minor issue with JSON schema. Ported to XSD and added XML t…

1e9cdce

…est case Signed-off-by: Steve Springett <steve@springett.us>

Fixed linting errors

8c5d03a

Signed-off-by: Steve Springett <steve@springett.us>

Merge branch '1.7-dev' into 1.7-dev-patents

2fe1e2e

Made patents optional

9776c2a

Signed-off-by: Steve Springett <steve@springett.us>

stevespringett added 2 commits May 2, 2025 17:45

Ported to protobuf and added test case

7f2978e

Signed-off-by: Steve Springett <steve@springett.us>

Updated comments

0bd4de7

Signed-off-by: Steve Springett <steve@springett.us>

stevespringett marked this pull request as ready for review May 2, 2025 22:53

stevespringett requested a review from a team as a code owner May 2, 2025 22:53

stevespringett changed the title ~~[WIP] v1.7 - Add patent support~~ Add patent support May 2, 2025

stevespringett changed the title ~~Add patent support~~ Add support for representing patent information May 2, 2025

stevespringett added request for comment RFC notice sent A public RFC notice was distributed to the CycloneDX mailing list for consideration labels May 2, 2025

jkowalleck self-requested a review May 15, 2025 12:36

docs: add ProtoBuf enum docs - taken from JSON

16f7632

Signed-off-by: Jan Kowalleck <jan.kowalleck@gmail.com>

jkowalleck approved these changes May 15, 2025

View reviewed changes

jkowalleck requested a review from a team May 15, 2025 15:07

jkowalleck added RFC vote accepted promote to tc54 Promote to Ecma Technical Committee 54 tc54 accepted Ecma TC54 has accepted the feature candidate labels Jun 5, 2025

jkowalleck mentioned this pull request Jun 5, 2025

v1.7 #511

Merged

jkowalleck merged commit 4cf9489 into 1.7-dev Jun 5, 2025
9 checks passed

stevespringett deleted the 1.7-dev-patents branch November 11, 2025 21:40

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Add support for representing patent information#597

Add support for representing patent information#597
jkowalleck merged 11 commits into1.7-devfrom
1.7-dev-patents

stevespringett commented Feb 10, 2025 •

edited

Loading

Uh oh!

Uh oh!

stevespringett commented Mar 10, 2025

Uh oh!

planetlevel commented Apr 3, 2025 via email

Uh oh!

stevespringett commented May 2, 2025

Uh oh!

jkowalleck commented May 2, 2025 •

edited

Loading

Uh oh!

stevespringett commented May 2, 2025

Uh oh!

jkowalleck left a comment •

edited

Loading

Uh oh!

jkowalleck commented Jun 5, 2025

Uh oh!

jkowalleck commented Jun 5, 2025

Uh oh!

Uh oh!

Nicolas-Peiffer commented Jun 6, 2025 •

edited

Loading

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

Uh oh!

Conversation

stevespringett commented Feb 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

stevespringett commented Mar 10, 2025

Uh oh!

planetlevel commented Apr 3, 2025 via email

Uh oh!

stevespringett commented May 2, 2025

Uh oh!

jkowalleck commented May 2, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

stevespringett commented May 2, 2025

Uh oh!

jkowalleck left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jkowalleck commented Jun 5, 2025

Uh oh!

jkowalleck commented Jun 5, 2025

Uh oh!

Uh oh!

Nicolas-Peiffer commented Jun 6, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

stevespringett commented Feb 10, 2025 •

edited

Loading

jkowalleck commented May 2, 2025 •

edited

Loading

jkowalleck left a comment •

edited

Loading

Nicolas-Peiffer commented Jun 6, 2025 •

edited

Loading